<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pybindgen.typehandlers.base</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pybindgen-module.html">Package&nbsp;pybindgen</a> ::
        <a href="pybindgen.typehandlers-module.html">Package&nbsp;typehandlers</a> ::
        Module&nbsp;base
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pybindgen.typehandlers.base-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module base</h1><p class="nomargin-top"><span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html">source&nbsp;code</a></span></p>
<p>Base classes for all parameter/return type handlers, and base 
  interfaces for wrapper generators.</p>

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Classes</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.CodegenErrorBase-class.html" class="summary-name">CodegenErrorBase</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.NotSupportedError-class.html" class="summary-name">NotSupportedError</a><br />
      Exception that is raised when declaring an interface configuration 
        that is not supported or not implemented.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.CodeGenerationError-class.html" class="summary-name">CodeGenerationError</a><br />
      Exception that is raised when wrapper generation fails for some 
        reason.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.TypeLookupError-class.html" class="summary-name">TypeLookupError</a><br />
      Exception that is raised when lookup of a type handler fails
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.TypeConfigurationError-class.html" class="summary-name">TypeConfigurationError</a><br />
      Exception that is raised when a type handler does not find some 
        information it needs, such as owernship transfer semantics.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.CodeBlock-class.html" class="summary-name">CodeBlock</a><br />
      An intelligent code block that keeps track of cleanup actions.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.ParseTupleParameters-class.html" class="summary-name">ParseTupleParameters</a><br />
      Object to keep track of PyArg_ParseTuple (or similar) parameters
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.BuildValueParameters-class.html" class="summary-name">BuildValueParameters</a><br />
      Object to keep track of Py_BuildValue (or similar) parameters
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.DeclarationsScope-class.html" class="summary-name">DeclarationsScope</a><br />
      Manages variable declarations in a given scope.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.ReverseWrapperBase-class.html" class="summary-name">ReverseWrapperBase</a><br />
      Generic base for all reverse wrapper generators.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.ForwardWrapperBase-class.html" class="summary-name">ForwardWrapperBase</a><br />
      Generic base for all forward wrapper generators.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.TypeTransformation-class.html" class="summary-name">TypeTransformation</a><br />
      Type transformations are used to register handling of special types
        that are simple transformation over another type that is already 
        registered.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.NullTypeTransformation-class.html" class="summary-name">NullTypeTransformation</a><br />
      Null type transformation, returns everything unchanged.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.TypeHandler-class.html" class="summary-name">TypeHandler</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.ReturnValue-class.html" class="summary-name">ReturnValue</a><br />
      Abstract base class for all classes dedicated to handle specific 
        return value types
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.PointerReturnValue-class.html" class="summary-name">PointerReturnValue</a><br />
      Base class for all pointer-to-something handlers
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.Parameter-class.html" class="summary-name">Parameter</a><br />
      Abstract base class for all classes dedicated to handle specific 
        parameter types
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.PointerParameter-class.html" class="summary-name">PointerParameter</a><br />
      Base class for all pointer-to-something handlers
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.typehandlers.base.TypeMatcher-class.html" class="summary-name">TypeMatcher</a><br />
      Type matcher object: maps C type names to classes that handle those
        types.
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Functions</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="all"></a><span class="summary-sig-name">all</span>(<span class="summary-sig-arg">iterable</span>)</span><br />
      Returns True if all elements are true</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#all">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.typehandlers.base-module.html#join_ctype_and_name" class="summary-sig-name">join_ctype_and_name</a>(<span class="summary-sig-arg">ctype</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Utility method that joins a C type and a variable name into a single 
      string</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#join_ctype_and_name">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_join_ctype_and_-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_join_ctype_and_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_join_ctype_and_" name="call_graph_for_join_ctype_and_">
<area shape="rect" href="pybindgen.cppclass.CppHelperClass-class.html#_generate_forward_declarations" title="cppclass.CppHelperClass._generate_forward_declarations()" alt="" coords="85,5,645,37"/>
<area shape="rect" href="pybindgen.typehandlers.base-module.html#join_ctype_and_name" title="join_ctype_and_name()" alt="" coords="775,117,1007,149"/>
<area shape="rect" href="pybindgen.cppmethod.CppVirtualMethodParentCaller-class.html#generate_parent_caller_method" title="cppmethod.CppVirtualMethodParentCaller.generate_parent_caller_method()" alt="" coords="5,61,725,93"/>
<area shape="rect" href="pybindgen.cppmethod.CppVirtualMethodProxy-class.html#generate_declaration" title="cppmethod.CppVirtualMethodProxy.generate_declaration()" alt="" coords="87,117,644,149"/>
<area shape="rect" href="pybindgen.typehandlers.base.DeclarationsScope-class.html#declare_variable" title="DeclarationsScope.declare_variable()" alt="" coords="185,173,545,205"/>
<area shape="rect" href="pybindgen.typehandlers.base.ReverseWrapperBase-class.html#generate" title="ReverseWrapperBase.generate()" alt="" coords="205,229,525,261"/>
</map>
  <img src="call_graph_for_join_ctype_and_.gif" alt='' usemap="#call_graph_for_join_ctype_and_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="add_type_alias"></a><span class="summary-sig-name">add_type_alias</span>(<span class="summary-sig-arg">from_type_name</span>,
        <span class="summary-sig-arg">to_type_name</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#add_type_alias">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_add_type_alias-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_add_type_alias-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_add_type_alias" name="call_graph_for_add_type_alias">
<area shape="rect" href="pybindgen.gccxmlparser.ModuleParser-class.html#_scan_namespace_types" title="gccxmlparser.ModuleParser._scan_namespace_types()" alt="" coords="7,5,516,37"/>
<area shape="rect" href="pybindgen.typehandlers.base-module.html#add_type_alias" title="add_type_alias()" alt="" coords="565,5,736,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.TypeMatcher-class.html#add_type_alias" title="TypeMatcher.add_type_alias()" alt="" coords="785,5,1076,37"/>
</map>
  <img src="call_graph_for_add_type_alias.gif" alt='' usemap="#call_graph_for_add_type_alias" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(&quot;pybindgen.typehandlers&quot;)">logging.getLogger(&quot;pybindgen.typehandlers&quot;)</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="return_type_matcher"></a><span class="summary-name">return_type_matcher</span> = <code title="TypeMatcher()">TypeMatcher()</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="param_type_matcher"></a><span class="summary-name">param_type_matcher</span> = <code title="TypeMatcher()">TypeMatcher()</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'pybindgen.typehandlers'"><code class="variable-quote">'</code><code class="variable-string">pybindgen.typehandlers</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="join_ctype_and_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">join_ctype_and_name</span>(<span class="sig-arg">ctype</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#join_ctype_and_name">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_join_ctype_and_-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for_join_ctype_and_-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_join_ctype_and_" name="call_graph_for_join_ctype_and_">
<area shape="rect" href="pybindgen.cppclass.CppHelperClass-class.html#_generate_forward_declarations" title="cppclass.CppHelperClass._generate_forward_declarations()" alt="" coords="85,5,645,37"/>
<area shape="rect" href="pybindgen.typehandlers.base-module.html#join_ctype_and_name" title="join_ctype_and_name()" alt="" coords="775,117,1007,149"/>
<area shape="rect" href="pybindgen.cppmethod.CppVirtualMethodParentCaller-class.html#generate_parent_caller_method" title="cppmethod.CppVirtualMethodParentCaller.generate_parent_caller_method()" alt="" coords="5,61,725,93"/>
<area shape="rect" href="pybindgen.cppmethod.CppVirtualMethodProxy-class.html#generate_declaration" title="cppmethod.CppVirtualMethodProxy.generate_declaration()" alt="" coords="87,117,644,149"/>
<area shape="rect" href="pybindgen.typehandlers.base.DeclarationsScope-class.html#declare_variable" title="DeclarationsScope.declare_variable()" alt="" coords="185,173,545,205"/>
<area shape="rect" href="pybindgen.typehandlers.base.ReverseWrapperBase-class.html#generate" title="ReverseWrapperBase.generate()" alt="" coords="205,229,525,261"/>
</map>
  <img src="call_graph_for_join_ctype_and_.gif" alt='' usemap="#call_graph_for_join_ctype_and_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  <p>Utility method that joins a C type and a variable name into a single 
  string</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>join_ctype_and_name(<span class="py-string">'void*'</span>, <span class="py-string">'foo'</span>)
<span class="py-output">'void *foo'</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>join_ctype_and_name(<span class="py-string">'void *'</span>, <span class="py-string">'foo'</span>)
<span class="py-output">'void *foo'</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>join_ctype_and_name(<span class="py-string">&quot;void**&quot;</span>, <span class="py-string">&quot;foo&quot;</span>)
<span class="py-output">'void **foo'</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>join_ctype_and_name(<span class="py-string">&quot;void **&quot;</span>, <span class="py-string">&quot;foo&quot;</span>)
<span class="py-output">'void **foo'</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>join_ctype_and_name(<span class="py-string">'C*'</span>, <span class="py-string">'foo'</span>)
<span class="py-output">'C *foo'</span></pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Jul 12 17:23:07 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
